<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: jetson-utils/Networking.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Networking_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Networking.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Networking_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef __NETWORKING_H_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define __NETWORKING_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IPv4_8h.html">IPv4.h</a>&quot;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IPv6_8h.html">IPv6.h</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;std::string <a class="code" href="group__network.html#ga4eeeacba2fc1201c43d42a4f5145b825">getHostname</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;std::string <a class="code" href="group__network.html#ga604bb0e239d02117b959fda9ffd28c9a">getHostByName</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* name, uint32_t retries=10 );</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;uint32_t <a class="code" href="group__network.html#ga604bb0e239d02117b959fda9ffd28c9a">getHostByName</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">void</span>* ipAddress, uint32_t size, uint32_t retries=10 );</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__network.html">   78</a></span>&#160;<span class="keyword">struct </span><a class="code" href="group__network.html#structNetworkInterface">NetworkInterface</a></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;{</div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="group__network.html#a36f3119ebeebc4f41a339dfd9ad329d4">   80</a></span>&#160;        std::string <a class="code" href="group__network.html#a36f3119ebeebc4f41a339dfd9ad329d4">name</a>;                       </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="group__network.html#abe51eb63965aedb79524afd991ee077d">   81</a></span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="group__network.html#abe51eb63965aedb79524afd991ee077d">up</a>;                                        </div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv4.html">   83</a></span>&#160;        <span class="keyword">struct </span><a class="code" href="structNetworkInterface_1_1IPv4.html">IPv4</a></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        {</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv4.html#a1df5dd971891858041d4d310f921c6ec">   85</a></span>&#160;                std::string <a class="code" href="structNetworkInterface_1_1IPv4.html#a1df5dd971891858041d4d310f921c6ec">address</a>;    </div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv4.html#a9e7c31e9b8ffd2137f9f11eb4edaa58d">   86</a></span>&#160;                std::string <a class="code" href="structNetworkInterface_1_1IPv4.html#a9e7c31e9b8ffd2137f9f11eb4edaa58d">netmask</a>;    </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv4.html#a23c805adf54a92ad7fba25d10285f9a9">   87</a></span>&#160;                std::string <a class="code" href="structNetworkInterface_1_1IPv4.html#a23c805adf54a92ad7fba25d10285f9a9">broadcast</a>;  </div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        } <a class="code" href="group__network.html#ac5ed1543c19ac9600faea3c2d3caf5c7">ipv4</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        </div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv6.html">   90</a></span>&#160;        <span class="keyword">struct </span><a class="code" href="structNetworkInterface_1_1IPv6.html">IPv6</a></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        {</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv6.html#a665c42b91cbd6f7033d8068a57135a74">   92</a></span>&#160;                std::string <a class="code" href="structNetworkInterface_1_1IPv6.html#a665c42b91cbd6f7033d8068a57135a74">address</a>;    </div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="structNetworkInterface_1_1IPv6.html#a8d8d7313a0be1e0ddfec26a97d87a846">   93</a></span>&#160;                std::string <a class="code" href="structNetworkInterface_1_1IPv6.html#a8d8d7313a0be1e0ddfec26a97d87a846">prefix</a>;             </div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        } <a class="code" href="group__network.html#a0303c41a0e338773749eb8772dea3f15">ipv6</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;};</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;std::vector&lt;NetworkInterface&gt; <a class="code" href="group__network.html#gab929e511b041783d8dd4650f17d80dbd">getNetworkInterfaces</a>();</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="keywordtype">int</span> <a class="code" href="Networking_8h.html#ac7961e41144dce09b53436883bf51f3e">findNetworkInterface</a>( <span class="keyword">const</span> std::vector&lt;NetworkInterface&gt;&amp; interfaces, <span class="keyword">const</span> <span class="keywordtype">char</span>* name );</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__network.html#gad1ca82becf0918d589ec9938b51a977b">printNetworkInterfaces</a>( <span class="keyword">const</span> std::vector&lt;NetworkInterface&gt;&amp; interfaces );</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="group__network.html#gaadcbced28f4da19dc28dafcb1caf262b">  123</a></span>&#160;<span class="preprocessor">#define LOG_NETWORK &quot;[network] &quot;</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160; </div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agroup__network_html_a0303c41a0e338773749eb8772dea3f15"><div class="ttname"><a href="group__network.html#a0303c41a0e338773749eb8772dea3f15">NetworkInterface::ipv6</a></div><div class="ttdeci">struct NetworkInterface::IPv6 ipv6</div></div>
<div class="ttc" id="agroup__network_html_gab929e511b041783d8dd4650f17d80dbd"><div class="ttname"><a href="group__network.html#gab929e511b041783d8dd4650f17d80dbd">getNetworkInterfaces</a></div><div class="ttdeci">std::vector&lt; NetworkInterface &gt; getNetworkInterfaces()</div><div class="ttdoc">Retrieve info about the different IPv4/IPv6 network interfaces of the system.</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv4_html"><div class="ttname"><a href="structNetworkInterface_1_1IPv4.html">NetworkInterface::IPv4</a></div><div class="ttdef"><b>Definition:</b> Networking.h:83</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv6_html_a8d8d7313a0be1e0ddfec26a97d87a846"><div class="ttname"><a href="structNetworkInterface_1_1IPv6.html#a8d8d7313a0be1e0ddfec26a97d87a846">NetworkInterface::IPv6::prefix</a></div><div class="ttdeci">std::string prefix</div><div class="ttdoc">IPv6 prefix.</div><div class="ttdef"><b>Definition:</b> Networking.h:93</div></div>
<div class="ttc" id="agroup__network_html_abe51eb63965aedb79524afd991ee077d"><div class="ttname"><a href="group__network.html#abe51eb63965aedb79524afd991ee077d">NetworkInterface::up</a></div><div class="ttdeci">bool up</div><div class="ttdoc">true if the interface is up, false if down</div><div class="ttdef"><b>Definition:</b> Networking.h:81</div></div>
<div class="ttc" id="agroup__network_html_ga604bb0e239d02117b959fda9ffd28c9a"><div class="ttname"><a href="group__network.html#ga604bb0e239d02117b959fda9ffd28c9a">getHostByName</a></div><div class="ttdeci">std::string getHostByName(const char *name, uint32_t retries=10)</div><div class="ttdoc">Resolve the IP address of a given hostname or domain using DNS lookup, and return it as a string.</div></div>
<div class="ttc" id="agroup__network_html_gad1ca82becf0918d589ec9938b51a977b"><div class="ttname"><a href="group__network.html#gad1ca82becf0918d589ec9938b51a977b">printNetworkInterfaces</a></div><div class="ttdeci">void printNetworkInterfaces(const std::vector&lt; NetworkInterface &gt; &amp;interfaces)</div><div class="ttdoc">Print out a list of network interfaces.</div></div>
<div class="ttc" id="aNetworking_8h_html_ac7961e41144dce09b53436883bf51f3e"><div class="ttname"><a href="Networking_8h.html#ac7961e41144dce09b53436883bf51f3e">findNetworkInterface</a></div><div class="ttdeci">int findNetworkInterface(const std::vector&lt; NetworkInterface &gt; &amp;interfaces, const char *name)</div><div class="ttdoc">Find the index of a network interface by name from the list of interfaces.</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv4_html_a23c805adf54a92ad7fba25d10285f9a9"><div class="ttname"><a href="structNetworkInterface_1_1IPv4.html#a23c805adf54a92ad7fba25d10285f9a9">NetworkInterface::IPv4::broadcast</a></div><div class="ttdeci">std::string broadcast</div><div class="ttdoc">IPv4 broadcast.</div><div class="ttdef"><b>Definition:</b> Networking.h:87</div></div>
<div class="ttc" id="agroup__network_html_ga4eeeacba2fc1201c43d42a4f5145b825"><div class="ttname"><a href="group__network.html#ga4eeeacba2fc1201c43d42a4f5145b825">getHostname</a></div><div class="ttdeci">std::string getHostname()</div><div class="ttdoc">Retrieve the host system's network hostname.</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv4_html_a9e7c31e9b8ffd2137f9f11eb4edaa58d"><div class="ttname"><a href="structNetworkInterface_1_1IPv4.html#a9e7c31e9b8ffd2137f9f11eb4edaa58d">NetworkInterface::IPv4::netmask</a></div><div class="ttdeci">std::string netmask</div><div class="ttdoc">IPv4 netmask.</div><div class="ttdef"><b>Definition:</b> Networking.h:86</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv4_html_a1df5dd971891858041d4d310f921c6ec"><div class="ttname"><a href="structNetworkInterface_1_1IPv4.html#a1df5dd971891858041d4d310f921c6ec">NetworkInterface::IPv4::address</a></div><div class="ttdeci">std::string address</div><div class="ttdoc">IPv4 address.</div><div class="ttdef"><b>Definition:</b> Networking.h:85</div></div>
<div class="ttc" id="agroup__network_html_structNetworkInterface"><div class="ttname"><a href="group__network.html#structNetworkInterface">NetworkInterface</a></div><div class="ttdoc">Info about a particular network interface.</div><div class="ttdef"><b>Definition:</b> Networking.h:78</div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv6_html"><div class="ttname"><a href="structNetworkInterface_1_1IPv6.html">NetworkInterface::IPv6</a></div><div class="ttdef"><b>Definition:</b> Networking.h:90</div></div>
<div class="ttc" id="agroup__network_html_ac5ed1543c19ac9600faea3c2d3caf5c7"><div class="ttname"><a href="group__network.html#ac5ed1543c19ac9600faea3c2d3caf5c7">NetworkInterface::ipv4</a></div><div class="ttdeci">struct NetworkInterface::IPv4 ipv4</div></div>
<div class="ttc" id="agroup__network_html_a36f3119ebeebc4f41a339dfd9ad329d4"><div class="ttname"><a href="group__network.html#a36f3119ebeebc4f41a339dfd9ad329d4">NetworkInterface::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">name of the network interface (e.g.</div><div class="ttdef"><b>Definition:</b> Networking.h:80</div></div>
<div class="ttc" id="aIPv4_8h_html"><div class="ttname"><a href="IPv4_8h.html">IPv4.h</a></div></div>
<div class="ttc" id="aIPv6_8h_html"><div class="ttname"><a href="IPv6_8h.html">IPv6.h</a></div></div>
<div class="ttc" id="astructNetworkInterface_1_1IPv6_html_a665c42b91cbd6f7033d8068a57135a74"><div class="ttname"><a href="structNetworkInterface_1_1IPv6.html#a665c42b91cbd6f7033d8068a57135a74">NetworkInterface::IPv6::address</a></div><div class="ttdeci">std::string address</div><div class="ttdoc">IPv6 address.</div><div class="ttdef"><b>Definition:</b> Networking.h:92</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_54a0acf6da04fe2ed9410b4c6369bc5d.html">jetson-utils</a></li><li class="navelem"><a class="el" href="Networking_8h.html">Networking.h</a></li>
    <li class="footer">Generated on Tue Mar 28 2023 14:27:58 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
